package runnerworm.core;

/**
 * <p>Title: GameOptions</p>
 * <p>Description: This class will hold the game's options such as the game's
 * level. At first, it will hold only the level. Maybe later it can hold more
 * options.</p>
 * @author Guilherme Mauro Germoglio Barbosa
 */

public class GameOptions {

  /**
   * The identification for the easy level.
   */
  public final static int EASY_LEVEL = 1;
  /**
   * The identification for the medium level.
   */
  public final static int MEDIUM_LEVEL = 3;
  /**
   * The identification for the hard level.
   */
  public final static int HARD_LEVEL = 5;

  /**
   * The level option choosen by the user.
   */
  private int currentLevel;

  /**
   * Default constructor, will set the current level to the medium one.
   */
  public GameOptions() {
    this.currentLevel = MEDIUM_LEVEL;
  }

  /**
   * Sets the current level.
   * @param newLevel The new level choosen.
   */
  public void setCurrentLevel(int newLevel) {
    this.currentLevel = newLevel;
  }

  /**
   * Returns the current level.
   * @return The current level.
   */
  public int getCurrentLevel() {
    return currentLevel;
  }

}